# This Python file uses the following encoding: utf-8
#############################################################################
##
## Copyright (C) 2020 The Qt Company Ltd.
## Contact: https://www.qt.io/licensing/
##
## This file is part of Qt for Python.
##
## $QT_BEGIN_LICENSE:LGPL$
## Commercial License Usage
## Licensees holding valid commercial Qt licenses may use this file in
## accordance with the commercial license agreement provided with the
## Software or, alternatively, in accordance with the terms contained in
## a written agreement between you and The Qt Company. For licensing terms
## and conditions see https://www.qt.io/terms-conditions. For further
## information use the contact form at https://www.qt.io/contact-us.
##
## GNU Lesser General Public License Usage
## Alternatively, this file may be used under the terms of the GNU Lesser
## General Public License version 3 as published by the Free Software
## Foundation and appearing in the file LICENSE.LGPL3 included in the
## packaging of this file. Please review the following information to
## ensure the GNU Lesser General Public License version 3 requirements
## will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
##
## GNU General Public License Usage
## Alternatively, this file may be used under the terms of the GNU
## General Public License version 2.0 or (at your option) the GNU General
## Public license version 3 or any later version approved by the KDE Free
## Qt Foundation. The licenses are as published by the Free Software
## Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
## included in the packaging of this file. Please review the following
## information to ensure the GNU General Public License requirements will
## be met: https://www.gnu.org/licenses/gpl-2.0.html and
## https://www.gnu.org/licenses/gpl-3.0.html.
##
## $QT_END_LICENSE$
##
#############################################################################

"""
This file contains the exact signatures for all functions in module
Qt.QtHelp, except for defaults which are replaced by "...".
"""

# Module Qt.QtHelp
import Qt
try:
    import typing
except ImportError:
    from Qt.support.signature import typing
from Qt.support.signature.mapping import (
    Virtual, Missing, Invalid, Default, Instance)

class Object(object): pass

import shiboken2 as Shiboken
Shiboken.Object = Object

import Qt.QtCore
import Qt.QtGui
import Qt.QtWidgets
import Qt.QtHelp


class QCompressedHelpInfo(Shiboken.Object):

    @typing.overload
    def __init__(self): ...
    @typing.overload
    def __init__(self, other:Qt.QtHelp.QCompressedHelpInfo): ...

    def __copy__(self): ...
    def component(self) -> str: ...
    @staticmethod
    def fromCompressedHelpFile(documentationFileName:str) -> Qt.QtHelp.QCompressedHelpInfo: ...
    def isNull(self) -> bool: ...
    def namespaceName(self) -> str: ...
    def swap(self, other:Qt.QtHelp.QCompressedHelpInfo): ...
    def version(self) -> Qt.QtCore.QVersionNumber: ...


class QHelpContentItem(Shiboken.Object):
    def __copy__(self): ...
    def child(self, row:int) -> Qt.QtHelp.QHelpContentItem: ...
    def childCount(self) -> int: ...
    def childPosition(self, child:Qt.QtHelp.QHelpContentItem) -> int: ...
    def parent(self) -> Qt.QtHelp.QHelpContentItem: ...
    def row(self) -> int: ...
    def title(self) -> str: ...
    def url(self) -> Qt.QtCore.QUrl: ...


class QHelpContentModel(Qt.QtCore.QAbstractItemModel):
    def columnCount(self, parent:Qt.QtCore.QModelIndex=...) -> int: ...
    def contentItemAt(self, index:Qt.QtCore.QModelIndex) -> Qt.QtHelp.QHelpContentItem: ...
    def createContents(self, customFilterName:str): ...
    def data(self, index:Qt.QtCore.QModelIndex, role:int) -> typing.Any: ...
    def index(self, row:int, column:int, parent:Qt.QtCore.QModelIndex=...) -> Qt.QtCore.QModelIndex: ...
    def isCreatingContents(self) -> bool: ...
    @typing.overload
    def parent(self) -> Qt.QtCore.QObject: ...
    @typing.overload
    def parent(self, index:Qt.QtCore.QModelIndex) -> Qt.QtCore.QModelIndex: ...
    def rowCount(self, parent:Qt.QtCore.QModelIndex=...) -> int: ...


class QHelpContentWidget(Qt.QtWidgets.QTreeView):
    def indexOf(self, link:Qt.QtCore.QUrl) -> Qt.QtCore.QModelIndex: ...


class QHelpEngine(Qt.QtHelp.QHelpEngineCore):

    def __init__(self, collectionFile:str, parent:typing.Optional[Qt.QtCore.QObject]=...): ...

    def contentModel(self) -> Qt.QtHelp.QHelpContentModel: ...
    def contentWidget(self) -> Qt.QtHelp.QHelpContentWidget: ...
    def indexModel(self) -> Qt.QtHelp.QHelpIndexModel: ...
    def indexWidget(self) -> Qt.QtHelp.QHelpIndexWidget: ...
    def searchEngine(self) -> Qt.QtHelp.QHelpSearchEngine: ...


class QHelpEngineCore(Qt.QtCore.QObject):

    def __init__(self, collectionFile:str, parent:typing.Optional[Qt.QtCore.QObject]=...): ...

    def addCustomFilter(self, filterName:str, attributes:typing.Sequence) -> bool: ...
    def autoSaveFilter(self) -> bool: ...
    def collectionFile(self) -> str: ...
    def copyCollectionFile(self, fileName:str) -> bool: ...
    def currentFilter(self) -> str: ...
    def customFilters(self) -> typing.List: ...
    def customValue(self, key:str, defaultValue:typing.Any=...) -> typing.Any: ...
    def documentationFileName(self, namespaceName:str) -> str: ...
    @typing.overload
    def documentsForIdentifier(self, id:str) -> typing.List: ...
    @typing.overload
    def documentsForIdentifier(self, id:str, filterName:str) -> typing.List: ...
    @typing.overload
    def documentsForKeyword(self, keyword:str) -> typing.List: ...
    @typing.overload
    def documentsForKeyword(self, keyword:str, filterName:str) -> typing.List: ...
    def error(self) -> str: ...
    def fileData(self, url:Qt.QtCore.QUrl) -> Qt.QtCore.QByteArray: ...
    @typing.overload
    def files(self, namespaceName:str, filterAttributes:typing.Sequence, extensionFilter:str=...) -> typing.List: ...
    @typing.overload
    def files(self, namespaceName:str, filterName:str, extensionFilter:str=...) -> typing.List: ...
    def filterAttributeSets(self, namespaceName:str) -> typing.List: ...
    @typing.overload
    def filterAttributes(self) -> typing.List: ...
    @typing.overload
    def filterAttributes(self, filterName:str) -> typing.List: ...
    def filterEngine(self) -> Qt.QtHelp.QHelpFilterEngine: ...
    def findFile(self, url:Qt.QtCore.QUrl) -> Qt.QtCore.QUrl: ...
    def linksForIdentifier(self, id:str) -> typing.Dict: ...
    def linksForKeyword(self, keyword:str) -> typing.Dict: ...
    @staticmethod
    def metaData(documentationFileName:str, name:str) -> typing.Any: ...
    @staticmethod
    def namespaceName(documentationFileName:str) -> str: ...
    def registerDocumentation(self, documentationFileName:str) -> bool: ...
    def registeredDocumentations(self) -> typing.List: ...
    def removeCustomFilter(self, filterName:str) -> bool: ...
    def removeCustomValue(self, key:str) -> bool: ...
    def setAutoSaveFilter(self, save:bool): ...
    def setCollectionFile(self, fileName:str): ...
    def setCurrentFilter(self, filterName:str): ...
    def setCustomValue(self, key:str, value:typing.Any) -> bool: ...
    def setUsesFilterEngine(self, uses:bool): ...
    def setupData(self) -> bool: ...
    def unregisterDocumentation(self, namespaceName:str) -> bool: ...
    def usesFilterEngine(self) -> bool: ...


class QHelpFilterData(Shiboken.Object):

    @typing.overload
    def __init__(self): ...
    @typing.overload
    def __init__(self, other:Qt.QtHelp.QHelpFilterData): ...

    def __copy__(self): ...
    def components(self) -> typing.List: ...
    def setComponents(self, components:typing.Sequence): ...
    def setVersions(self, versions:typing.Sequence): ...
    def swap(self, other:Qt.QtHelp.QHelpFilterData): ...
    def versions(self) -> typing.List: ...


class QHelpFilterEngine(Qt.QtCore.QObject):

    def __init__(self, helpEngine:Qt.QtHelp.QHelpEngineCore): ...

    def activeFilter(self) -> str: ...
    def availableComponents(self) -> typing.List: ...
    def availableVersions(self) -> typing.List: ...
    def filterData(self, filterName:str) -> Qt.QtHelp.QHelpFilterData: ...
    def filters(self) -> typing.List: ...
    @typing.overload
    def indices(self) -> typing.List: ...
    @typing.overload
    def indices(self, filterName:str) -> typing.List: ...
    def namespaceToComponent(self) -> typing.Dict: ...
    def namespaceToVersion(self) -> typing.Dict: ...
    def namespacesForFilter(self, filterName:str) -> typing.List: ...
    def removeFilter(self, filterName:str) -> bool: ...
    def setActiveFilter(self, filterName:str) -> bool: ...
    def setFilterData(self, filterName:str, filterData:Qt.QtHelp.QHelpFilterData) -> bool: ...


class QHelpFilterSettingsWidget(Qt.QtWidgets.QWidget):

    def __init__(self, parent:typing.Optional[Qt.QtWidgets.QWidget]=...): ...

    def applySettings(self, filterEngine:Qt.QtHelp.QHelpFilterEngine) -> bool: ...
    def readSettings(self, filterEngine:Qt.QtHelp.QHelpFilterEngine): ...
    def setAvailableComponents(self, components:typing.Sequence): ...
    def setAvailableVersions(self, versions:typing.Sequence): ...


class QHelpIndexModel(Qt.QtCore.QStringListModel):
    @typing.overload
    def createIndex(self, customFilterName:str): ...
    @typing.overload
    def createIndex(self, row:int, column:int, id:int=...) -> Qt.QtCore.QModelIndex: ...
    @typing.overload
    def createIndex(self, row:int, column:int, ptr:object) -> Qt.QtCore.QModelIndex: ...
    def filter(self, filter:str, wildcard:str=...) -> Qt.QtCore.QModelIndex: ...
    def helpEngine(self) -> Qt.QtHelp.QHelpEngineCore: ...
    def isCreatingIndex(self) -> bool: ...
    def linksForKeyword(self, keyword:str) -> typing.Dict: ...


class QHelpIndexWidget(Qt.QtWidgets.QListView):
    def activateCurrentItem(self): ...
    def filterIndices(self, filter:str, wildcard:str=...): ...


class QHelpLink(Shiboken.Object):

    @typing.overload
    def __init__(self): ...
    @typing.overload
    def __init__(self, QHelpLink:Qt.QtHelp.QHelpLink): ...

    def __copy__(self): ...


class QHelpSearchEngine(Qt.QtCore.QObject):

    def __init__(self, helpEngine:Qt.QtHelp.QHelpEngineCore, parent:typing.Optional[Qt.QtCore.QObject]=...): ...

    def cancelIndexing(self): ...
    def cancelSearching(self): ...
    def hitCount(self) -> int: ...
    def hits(self, start:int, end:int) -> typing.List: ...
    def hitsCount(self) -> int: ...
    def query(self) -> typing.List: ...
    def queryWidget(self) -> Qt.QtHelp.QHelpSearchQueryWidget: ...
    def reindexDocumentation(self): ...
    def resultWidget(self) -> Qt.QtHelp.QHelpSearchResultWidget: ...
    def scheduleIndexDocumentation(self): ...
    @typing.overload
    def search(self, queryList:typing.Sequence): ...
    @typing.overload
    def search(self, searchInput:str): ...
    def searchInput(self) -> str: ...
    def searchResultCount(self) -> int: ...
    def searchResults(self, start:int, end:int) -> typing.List: ...


class QHelpSearchQuery(Shiboken.Object):
    DEFAULT                  : QHelpSearchQuery = ... # 0x0
    FUZZY                    : QHelpSearchQuery = ... # 0x1
    WITHOUT                  : QHelpSearchQuery = ... # 0x2
    PHRASE                   : QHelpSearchQuery = ... # 0x3
    ALL                      : QHelpSearchQuery = ... # 0x4
    ATLEAST                  : QHelpSearchQuery = ... # 0x5

    class FieldName(object):
        DEFAULT                  : QHelpSearchQuery.FieldName = ... # 0x0
        FUZZY                    : QHelpSearchQuery.FieldName = ... # 0x1
        WITHOUT                  : QHelpSearchQuery.FieldName = ... # 0x2
        PHRASE                   : QHelpSearchQuery.FieldName = ... # 0x3
        ALL                      : QHelpSearchQuery.FieldName = ... # 0x4
        ATLEAST                  : QHelpSearchQuery.FieldName = ... # 0x5

    @typing.overload
    def __init__(self): ...
    @typing.overload
    def __init__(self, QHelpSearchQuery:Qt.QtHelp.QHelpSearchQuery): ...
    @typing.overload
    def __init__(self, field:Qt.QtHelp.QHelpSearchQuery.FieldName, wordList_:typing.Sequence): ...

    def __copy__(self): ...


class QHelpSearchQueryWidget(Qt.QtWidgets.QWidget):

    def __init__(self, parent:typing.Optional[Qt.QtWidgets.QWidget]=...): ...

    def changeEvent(self, event:Qt.QtCore.QEvent): ...
    def collapseExtendedSearch(self): ...
    def expandExtendedSearch(self): ...
    def focusInEvent(self, focusEvent:Qt.QtGui.QFocusEvent): ...
    def isCompactMode(self) -> bool: ...
    def query(self) -> typing.List: ...
    def searchInput(self) -> str: ...
    def setCompactMode(self, on:bool): ...
    def setQuery(self, queryList:typing.Sequence): ...
    def setSearchInput(self, searchInput:str): ...


class QHelpSearchResult(Shiboken.Object):

    @typing.overload
    def __init__(self): ...
    @typing.overload
    def __init__(self, other:Qt.QtHelp.QHelpSearchResult): ...
    @typing.overload
    def __init__(self, url:Qt.QtCore.QUrl, title:str, snippet:str): ...

    def snippet(self) -> str: ...
    def title(self) -> str: ...
    def url(self) -> Qt.QtCore.QUrl: ...


class QHelpSearchResultWidget(Qt.QtWidgets.QWidget):
    def changeEvent(self, event:Qt.QtCore.QEvent): ...
    def linkAt(self, point:Qt.QtCore.QPoint) -> Qt.QtCore.QUrl: ...

# eof
